<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>graia.broadcast.entities.dispatcher API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>graia.broadcast.entities.dispatcher</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from abc import ABCMeta, abstractstaticmethod
from types import TracebackType
from typing import List, Optional, TYPE_CHECKING

if TYPE_CHECKING:
    from graia.broadcast.interfaces.dispatcher import DispatcherInterface


class BaseDispatcher(metaclass=ABCMeta):
    &#34;&#34;&#34;所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.&#34;&#34;&#34;

    mixin: List[&#34;BaseDispatcher&#34;]
    &#34;&#34;&#34;声明该 Dispatcher 所包含的来自其他 Dispatcher 提供的参数解析支持,
    若某参数该 Dispatcher 无法解析, 将跳转到该列表中并交由其中的 Dispatcher 进行解析,
    该列表中的 Dispatcher 全部被调用过且都不返回一有效值时才会将解析权交由其他的 Dispatcher.
    &#34;&#34;&#34;

    @abstractstaticmethod
    async def catch(interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;该方法可以是 `staticmethod`, `classmethod` 亦或是普通的方法/函数.
        唯一的要求是 `Dispatcher.catch` 获取到的必须为一可调用异步 Callable.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def beforeDispatch(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在解析参数前被调用

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def afterDispatch(
        self,
        interface: &#34;DispatcherInterface&#34;,
        exception: Optional[Exception],
        tb: Optional[TracebackType],
    ):
        &#34;&#34;&#34;生命周期钩子: 在参数被解析完后被调用

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
            exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
            tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        &#34;&#34;&#34;
        pass

    def beforeExecution(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在整个执行流程(包括参数解析)开始前被调用

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def afterExecution(
        self,
        interface: &#34;DispatcherInterface&#34;,
        exception: Optional[Exception],
        tb: Optional[TracebackType],
    ):
        &#34;&#34;&#34;生命周期钩子: 在整个执行流程(包括参数解析)完成(包含因异常被抛出而退出)后被调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
            exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
            tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        &#34;&#34;&#34;
        pass

    def beforeTargetExec(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在参数解析完成后, 准备执行事件执行主体前被调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def afterTargetExec(
        self,
        interface: &#34;DispatcherInterface&#34;,
        exception: Optional[Exception],
        tb: Optional[TracebackType],
    ):
        &#34;&#34;&#34;生命周期钩子: 在事件执行主体被执行完成后被调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
            exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
            tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        &#34;&#34;&#34;
        pass

    def onActive(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在该 Dispatcher 可用于参数解析时被立即调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher"><code class="flex name class">
<span>class <span class="ident">BaseDispatcher</span></span>
</code></dt>
<dd>
<div class="desc"><p>所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class BaseDispatcher(metaclass=ABCMeta):
    &#34;&#34;&#34;所有非单函数型 Dispatcher 的基类, 用于为参数解析提供可扩展的支持.&#34;&#34;&#34;

    mixin: List[&#34;BaseDispatcher&#34;]
    &#34;&#34;&#34;声明该 Dispatcher 所包含的来自其他 Dispatcher 提供的参数解析支持,
    若某参数该 Dispatcher 无法解析, 将跳转到该列表中并交由其中的 Dispatcher 进行解析,
    该列表中的 Dispatcher 全部被调用过且都不返回一有效值时才会将解析权交由其他的 Dispatcher.
    &#34;&#34;&#34;

    @abstractstaticmethod
    async def catch(interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;该方法可以是 `staticmethod`, `classmethod` 亦或是普通的方法/函数.
        唯一的要求是 `Dispatcher.catch` 获取到的必须为一可调用异步 Callable.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def beforeDispatch(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在解析参数前被调用

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def afterDispatch(
        self,
        interface: &#34;DispatcherInterface&#34;,
        exception: Optional[Exception],
        tb: Optional[TracebackType],
    ):
        &#34;&#34;&#34;生命周期钩子: 在参数被解析完后被调用

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
            exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
            tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        &#34;&#34;&#34;
        pass

    def beforeExecution(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在整个执行流程(包括参数解析)开始前被调用

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def afterExecution(
        self,
        interface: &#34;DispatcherInterface&#34;,
        exception: Optional[Exception],
        tb: Optional[TracebackType],
    ):
        &#34;&#34;&#34;生命周期钩子: 在整个执行流程(包括参数解析)完成(包含因异常被抛出而退出)后被调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
            exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
            tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        &#34;&#34;&#34;
        pass

    def beforeTargetExec(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在参数解析完成后, 准备执行事件执行主体前被调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass

    def afterTargetExec(
        self,
        interface: &#34;DispatcherInterface&#34;,
        exception: Optional[Exception],
        tb: Optional[TracebackType],
    ):
        &#34;&#34;&#34;生命周期钩子: 在事件执行主体被执行完成后被调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
            exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
            tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        &#34;&#34;&#34;
        pass

    def onActive(self, interface: &#34;DispatcherInterface&#34;):
        &#34;&#34;&#34;生命周期钩子: 在该 Dispatcher 可用于参数解析时被立即调用.

        Args:
            interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
             - 当前解析中的参数的信息;
             - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        &#34;&#34;&#34;
        pass</code></pre>
</details>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="graia.application.event.ApplicationDispatcher" href="../../application/event/index.html#graia.application.event.ApplicationDispatcher">ApplicationDispatcher</a></li>
<li><a title="graia.application.event.EmptyDispatcher" href="../../application/event/index.html#graia.application.event.EmptyDispatcher">EmptyDispatcher</a></li>
<li><a title="graia.application.event.dispatcher.MessageChainCatcher" href="../../application/event/dispatcher.html#graia.application.event.dispatcher.MessageChainCatcher">MessageChainCatcher</a></li>
<li><a title="graia.application.event.lifecycle.ApplicationLaunched.Dispatcher" href="../../application/event/lifecycle.html#graia.application.event.lifecycle.ApplicationLaunched.Dispatcher">ApplicationLaunched.Dispatcher</a></li>
<li><a title="graia.application.event.lifecycle.ApplicationLaunchedBlocking.Dispatcher" href="../../application/event/lifecycle.html#graia.application.event.lifecycle.ApplicationLaunchedBlocking.Dispatcher">ApplicationLaunchedBlocking.Dispatcher</a></li>
<li><a title="graia.application.event.lifecycle.ApplicationShutdowned.Dispatcher" href="../../application/event/lifecycle.html#graia.application.event.lifecycle.ApplicationShutdowned.Dispatcher">ApplicationShutdowned.Dispatcher</a></li>
<li><a title="graia.application.event.messages.Forward.Dispatcher" href="../../application/event/messages.html#graia.application.event.messages.Forward.Dispatcher">Forward.Dispatcher</a></li>
<li><a title="graia.application.event.messages.FriendMessage.Dispatcher" href="../../application/event/messages.html#graia.application.event.messages.FriendMessage.Dispatcher">FriendMessage.Dispatcher</a></li>
<li><a title="graia.application.event.messages.GroupMessage.Dispatcher" href="../../application/event/messages.html#graia.application.event.messages.GroupMessage.Dispatcher">GroupMessage.Dispatcher</a></li>
<li><a title="graia.application.event.messages.SourceElementDispatcher" href="../../application/event/messages.html#graia.application.event.messages.SourceElementDispatcher">SourceElementDispatcher</a></li>
<li><a title="graia.application.event.messages.TempMessage.Dispatcher" href="../../application/event/messages.html#graia.application.event.messages.TempMessage.Dispatcher">TempMessage.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.BotJoinGroupEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.BotJoinGroupEvent.Dispatcher">BotJoinGroupEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.BotLeaveEventActive.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.BotLeaveEventActive.Dispatcher">BotLeaveEventActive.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.BotLeaveEventKick.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.BotLeaveEventKick.Dispatcher">BotLeaveEventKick.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.BotMuteEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.BotMuteEvent.Dispatcher">BotMuteEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.BotUnmuteEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.BotUnmuteEvent.Dispatcher">BotUnmuteEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupAllowAnonymousChatEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupAllowAnonymousChatEvent.Dispatcher">GroupAllowAnonymousChatEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupAllowConfessTalkEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupAllowConfessTalkEvent.Dispatcher">GroupAllowConfessTalkEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupAllowMemberInviteEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupAllowMemberInviteEvent.Dispatcher">GroupAllowMemberInviteEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupEntranceAnnouncementChangeEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupEntranceAnnouncementChangeEvent.Dispatcher">GroupEntranceAnnouncementChangeEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupMuteAllEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupMuteAllEvent.Dispatcher">GroupMuteAllEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupNameChangeEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupNameChangeEvent.Dispatcher">GroupNameChangeEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.GroupRecallEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.GroupRecallEvent.Dispatcher">GroupRecallEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberCardChangeEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberCardChangeEvent.Dispatcher">MemberCardChangeEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberJoinEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberJoinEvent.Dispatcher">MemberJoinEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberLeaveEventKick.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberLeaveEventKick.Dispatcher">MemberLeaveEventKick.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberLeaveEventQuit.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberLeaveEventQuit.Dispatcher">MemberLeaveEventQuit.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberMuteEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberMuteEvent.Dispatcher">MemberMuteEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberPermissionChangeEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberPermissionChangeEvent.Dispatcher">MemberPermissionChangeEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberSpecialTitleChangeEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberSpecialTitleChangeEvent.Dispatcher">MemberSpecialTitleChangeEvent.Dispatcher</a></li>
<li><a title="graia.application.event.mirai.MemberUnmuteEvent.Dispatcher" href="../../application/event/mirai.html#graia.application.event.mirai.MemberUnmuteEvent.Dispatcher">MemberUnmuteEvent.Dispatcher</a></li>
<li><a title="graia.application.message.parser.literature.Literature" href="../../application/message/parser/literature.html#graia.application.message.parser.literature.Literature">Literature</a></li>
<li><a title="graia.application.utilles.AppMiddlewareAsDispatcher" href="../../application/utilles.html#graia.application.utilles.AppMiddlewareAsDispatcher">AppMiddlewareAsDispatcher</a></li>
<li><a title="graia.broadcast.builtin.event.ExceptionThrowed.Dispatcher" href="../builtin/event.html#graia.broadcast.builtin.event.ExceptionThrowed.Dispatcher">ExceptionThrowed.Dispatcher</a></li>
<li><a title="graia.broadcast.builtin.factory.AsyncDispatcherContextManager" href="../builtin/factory.html#graia.broadcast.builtin.factory.AsyncDispatcherContextManager">AsyncDispatcherContextManager</a></li>
<li><a title="graia.broadcast.builtin.factory.DispatcherContextManager" href="../builtin/factory.html#graia.broadcast.builtin.factory.DispatcherContextManager">DispatcherContextManager</a></li>
<li><a title="graia.broadcast.interfaces.decorator.DecoratorInterface" href="../interfaces/decorator.html#graia.broadcast.interfaces.decorator.DecoratorInterface">DecoratorInterface</a></li>
<li><a title="graia.broadcast.interfaces.dispatcher.EmptyEvent.Dispatcher" href="../interfaces/dispatcher.html#graia.broadcast.interfaces.dispatcher.EmptyEvent.Dispatcher">EmptyEvent.Dispatcher</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.mixin"><code class="name">var <span class="ident">mixin</span> : List[<a title="graia.broadcast.entities.dispatcher.BaseDispatcher" href="#graia.broadcast.entities.dispatcher.BaseDispatcher">BaseDispatcher</a>]</code></dt>
<dd>
<div class="desc"><p>声明该 Dispatcher 所包含的来自其他 Dispatcher 提供的参数解析支持,
若某参数该 Dispatcher 无法解析, 将跳转到该列表中并交由其中的 Dispatcher 进行解析,
该列表中的 Dispatcher 全部被调用过且都不返回一有效值时才会将解析权交由其他的 Dispatcher.</p></div>
</dd>
</dl>
<h3>Static methods</h3>
<dl>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.catch"><code class="name flex">
<span>async def <span class="ident">catch</span></span>(<span>interface: DispatcherInterface)</span>
</code></dt>
<dd>
<div class="desc"><p>该方法可以是 <code>staticmethod</code>, <code>classmethod</code> 亦或是普通的方法/函数.
唯一的要求是 <code>Dispatcher.catch</code> 获取到的必须为一可调用异步 Callable.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@abstractstaticmethod
async def catch(interface: &#34;DispatcherInterface&#34;):
    &#34;&#34;&#34;该方法可以是 `staticmethod`, `classmethod` 亦或是普通的方法/函数.
    唯一的要求是 `Dispatcher.catch` 获取到的必须为一可调用异步 Callable.

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.afterDispatch"><code class="name flex">
<span>def <span class="ident">afterDispatch</span></span>(<span>self, interface: DispatcherInterface, exception: Union[Exception, NoneType], tb: Union[traceback, NoneType])</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在参数被解析完后被调用</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>
<dl>
<dt>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</dt>
<dt><strong><code>exception</code></strong> :&ensp;<code>Optional[Exception]</code></dt>
<dd>可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.</dd>
</dl>
</li>
</ul>
<dl>
<dt><strong><code>tb</code></strong> :&ensp;<code>Optional[TracebackType]</code></dt>
<dd>可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def afterDispatch(
    self,
    interface: &#34;DispatcherInterface&#34;,
    exception: Optional[Exception],
    tb: Optional[TracebackType],
):
    &#34;&#34;&#34;生命周期钩子: 在参数被解析完后被调用

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.afterExecution"><code class="name flex">
<span>def <span class="ident">afterExecution</span></span>(<span>self, interface: DispatcherInterface, exception: Union[Exception, NoneType], tb: Union[traceback, NoneType])</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在整个执行流程(包括参数解析)完成(包含因异常被抛出而退出)后被调用.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>
<dl>
<dt>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</dt>
<dt><strong><code>exception</code></strong> :&ensp;<code>Optional[Exception]</code></dt>
<dd>可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.</dd>
</dl>
</li>
</ul>
<dl>
<dt><strong><code>tb</code></strong> :&ensp;<code>Optional[TracebackType]</code></dt>
<dd>可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def afterExecution(
    self,
    interface: &#34;DispatcherInterface&#34;,
    exception: Optional[Exception],
    tb: Optional[TracebackType],
):
    &#34;&#34;&#34;生命周期钩子: 在整个执行流程(包括参数解析)完成(包含因异常被抛出而退出)后被调用.

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.afterTargetExec"><code class="name flex">
<span>def <span class="ident">afterTargetExec</span></span>(<span>self, interface: DispatcherInterface, exception: Union[Exception, NoneType], tb: Union[traceback, NoneType])</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在事件执行主体被执行完成后被调用.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>
<dl>
<dt>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</dt>
<dt><strong><code>exception</code></strong> :&ensp;<code>Optional[Exception]</code></dt>
<dd>可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.</dd>
</dl>
</li>
</ul>
<dl>
<dt><strong><code>tb</code></strong> :&ensp;<code>Optional[TracebackType]</code></dt>
<dd>可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def afterTargetExec(
    self,
    interface: &#34;DispatcherInterface&#34;,
    exception: Optional[Exception],
    tb: Optional[TracebackType],
):
    &#34;&#34;&#34;生命周期钩子: 在事件执行主体被执行完成后被调用.

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
        exception (Optional[Exception]): 可能存在的异常对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
        tb (Optional[TracebackType]): 可能存在的异常堆栈对象, 若为 None 则表示无异常被抛出, 执行顺利完成.
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.beforeDispatch"><code class="name flex">
<span>def <span class="ident">beforeDispatch</span></span>(<span>self, interface: DispatcherInterface)</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在解析参数前被调用</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def beforeDispatch(self, interface: &#34;DispatcherInterface&#34;):
    &#34;&#34;&#34;生命周期钩子: 在解析参数前被调用

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.beforeExecution"><code class="name flex">
<span>def <span class="ident">beforeExecution</span></span>(<span>self, interface: DispatcherInterface)</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在整个执行流程(包括参数解析)开始前被调用</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def beforeExecution(self, interface: &#34;DispatcherInterface&#34;):
    &#34;&#34;&#34;生命周期钩子: 在整个执行流程(包括参数解析)开始前被调用

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.beforeTargetExec"><code class="name flex">
<span>def <span class="ident">beforeTargetExec</span></span>(<span>self, interface: DispatcherInterface)</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在参数解析完成后, 准备执行事件执行主体前被调用.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def beforeTargetExec(self, interface: &#34;DispatcherInterface&#34;):
    &#34;&#34;&#34;生命周期钩子: 在参数解析完成后, 准备执行事件执行主体前被调用.

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
<dt id="graia.broadcast.entities.dispatcher.BaseDispatcher.onActive"><code class="name flex">
<span>def <span class="ident">onActive</span></span>(<span>self, interface: DispatcherInterface)</span>
</code></dt>
<dd>
<div class="desc"><p>生命周期钩子: 在该 Dispatcher 可用于参数解析时被立即调用.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>interface</code></strong> :&ensp;<code>DispatcherInterface</code></dt>
<dd><code>Dispatcher</code> 服务的主要对象, 可以从其中获取以下信息:</dd>
</dl>
<ul>
<li>当前解析中的参数的信息;</li>
<li>当前执行的信息, 比如正在处理的事件, <code>Listener</code>/<code>ExecTarget</code> etc.;</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def onActive(self, interface: &#34;DispatcherInterface&#34;):
    &#34;&#34;&#34;生命周期钩子: 在该 Dispatcher 可用于参数解析时被立即调用.

    Args:
        interface (DispatcherInterface): `Dispatcher` 服务的主要对象, 可以从其中获取以下信息:
         - 当前解析中的参数的信息;
         - 当前执行的信息, 比如正在处理的事件, `Listener`/`ExecTarget` etc.;
    &#34;&#34;&#34;
    pass</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="graia.broadcast.entities" href="index.html">graia.broadcast.entities</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher" href="#graia.broadcast.entities.dispatcher.BaseDispatcher">BaseDispatcher</a></code></h4>
<ul class="two-column">
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.afterDispatch" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.afterDispatch">afterDispatch</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.afterExecution" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.afterExecution">afterExecution</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.afterTargetExec" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.afterTargetExec">afterTargetExec</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.beforeDispatch" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.beforeDispatch">beforeDispatch</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.beforeExecution" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.beforeExecution">beforeExecution</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.beforeTargetExec" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.beforeTargetExec">beforeTargetExec</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.catch" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.catch">catch</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.mixin" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.mixin">mixin</a></code></li>
<li><code><a title="graia.broadcast.entities.dispatcher.BaseDispatcher.onActive" href="#graia.broadcast.entities.dispatcher.BaseDispatcher.onActive">onActive</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
</footer>
</body>
</html>